Is Customer in Segment API: isCustomerInSegment

The Is Customer in Segment API is used to determine if a customer belongs to a specific segment by providing the segment ID. This API is particularly useful for checking a customer's affiliation with particular segments in real-time CDP.

API Endpoint and Method

URL Format

Copy 
https://{B2B_API_URL}/api/v1/profile/b2b/isCustomerInSegment?segmentId={}

Example URL

Copy 
https://api-dev.algonomy.com/rcdpapi/api/v1/profile/b2b/isCustomerInSegment?segmentId=1

HTTP Method

POST

Request Header Parameters

Parameter

 Type Required or Optional

Description
access_token

String

Required

 Specifies the access token obtained from the create access token API.
tenant_hash

String

Required

 Specifies the tenant hash shared with the tenant.
gcrId String Required Specifies the Golden Customer Record ID (GCR ID).
mobile_number String Required

Specifies customer's mobile number.

Example: "1212121212"
email_address String Required

Specifies customer's email address.

Example: "customer@example.com"

customer_code_external

String

Required

Specifies the external customer code.

Example: "123456"
    Notes:

  • You can send all the parameters (gcrId, mobile_number, and email_address) with the request or just one, as at least one parameter is required.

  • These parameters are supported based on the configuration. If your deployment is configured to use them as columns for deduplication, they will be available for use in the API call.

Request Body

None.

Response Body

A successful request returns a "200-OK" status code, accompanied by the retrieved data in the response.

Copy 
{
  "status": "OK",
  "message": "",
  "data": {
    "status": true
  }
}